Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

a few code block rewrite to get it pretty #611

Merged
merged 1 commit into from
Oct 5, 2022
Merged

a few code block rewrite to get it pretty #611

merged 1 commit into from
Oct 5, 2022

Conversation

ebarboni
Copy link
Contributor

I wanted to fix apache/netbeans#4520
But I fix a bit more files.

IF subs=macros is used, <> clash with parser I guess so it should be rewritted as javadoc with <.

I try to keep the bold in the code to see how it render but I thinks it's not very readable.
I tweak the tutorials/nbm-projecttypeant.html to use hash to get it in yellow and see difference.

I guess we need some helper like in #537

@mbien
Copy link
Member

mbien commented Sep 21, 2022

is there no better way of doing this? Manually escaping characters in documentation code can be fairly annoying and is easy to overlook in updates.

I wrote a plugin for apache roller which can escape <pre> and <code> segments automatically, all I have to do is to paste code into my blog the rest is done before it is translated to html. I am wondering if jbake can do the same?

@ebarboni
Copy link
Contributor Author

forget to read the doc, using verbatim in subs do the trick.

vieiro
vieiro approved these changes Oct 4, 2022
View reviewed changes
Copy link
Contributor

@vieiro vieiro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything looks sane to me (did a quick look, though).
We should start dropping those /71, /69, /73, etc. folders: that content for previous NetBeans versions is ok for having a history, but we won't be maintaining them any longer.

@vieiro
Copy link
Contributor

vieiro commented Oct 4, 2022

@mbien , @ebarboni , You're right: no need to quote stuff in asciidoc, verbatim just works.

@ebarboni
Copy link
Contributor Author

ebarboni commented Oct 4, 2022

I will merge this.
Was thinking on moving locale to localfolder for non english like pt-PR a bit like last paragrah on https://maven.apache.org/plugins/maven-site-plugin/examples/creating-content.html so source will have smaller file per folder (the build system could put the mess back :D)

For the old tutorial I think we should move them inside the git but they should not be published. Better not have them live than having 404.

@ebarboni ebarboni merged commit 68fbc76 into apache:master Oct 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vieiro vieiro vieiro approved these changes

@mbien mbien mbien approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

NetBeans Editor Component Palette Module Tutorial, garbled source
3 participants
@ebarboni @mbien @vieiro